home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1998 #2 / Amiga Plus CD - 1998 - No. 2.iso / multimedia / scene-demos / animtrac_1.0 / animtrac_readme.txt next >
Text File  |  1980-01-04  |  15KB  |  443 lines
  1.  
  2. Welcome to "AnimTRAC!" v1.0a, (c)opyright 1997 Martin Edwards.
  3. -----------------------------------------------------------------------------
  4. (In the red corner, animations of one resolution/bitplanes/palette.
  5.  In the blue corner..)
  6.  
  7.  
  8. Token legal jargon..
  9. -----------------------------------------------------------------------------
  10. "AnimTRAC"   is Public Domain..
  11. "AnimTRACsc" is NOT Public Domain (script-compiler)..
  12. "CBF"        is Public Domain..
  13. "RBF"        is Public Domain..
  14.  
  15.  
  16. Instead of the usual documentation/readme, Dash will be asking dip-s**t
  17. questions to get the reader/potential-user interested..
  18.  
  19. Fire away, Dash!
  20.  
  21. - Okaz, what is AnimTRAC!?
  22.  
  23.   Super effort that!
  24.   The true genius that you are will register that in your head as
  25.                                                 Animation Tracker..
  26.  
  27. - Too right, what's a Tracker?
  28.  
  29.   Another word for sequencer, as in a music making program like OctaMED(tm)..
  30.  
  31. - So why not call it SuperHyperSpecialEditionTurboAlphaZero&FriendsTracker?
  32.  
  33.   Because AnimTRAC! looks better, besides i'd hate to get on the wrong side
  34.   of those Capcom boyz.. sheesh..
  35.  
  36. - Okay then, why does Amiga need another Animation Sequencer then, surely
  37.   there's plenty already out there?
  38.  
  39.   Well there's jack s**t really, and they're all bollocks..
  40.  
  41. - Erm, yeah.. So why is AnimTRAC the new standard in no-frills
  42.   Animation Sequencing?
  43.  
  44.   Well put..
  45.  
  46. - Ouw shucks..
  47.  
  48.   For a start it's just bloody marvellous..
  49.   Everything's double-buffered,
  50.   frames can be of any resolution and up to 8-bitplanes on AGA,
  51.   smooth fade'ins and outs and all a'bouts,
  52.   multi-directional scrolling on big-overscan frames,
  53.   plays ProTrackers and/or samples in any channel at any pitch,..
  54.  
  55. - Cor! Anymore and i'll explode all over your keyboard..
  56.  
  57.   I'll give you a 5-minute breather..
  58.  
  59.   (5-mins later)
  60.  
  61. - But wait! There's more?
  62.  
  63.   Multiple palette's,
  64.   edit frames in numerous ways,
  65.   frames are loaded to fastmem unless specified,
  66.   optional-instant viewing of frames in chipmem,
  67.   and most of all, a piss-easy syntax.. (and it's just version 1.0)
  68.  
  69. - Any free steak-knives then?
  70.  
  71.   HELL NO! I want you to be the next budding Eric-Schwartzy animator,
  72.   not some crazy steak-knife-throwing-freak(tm). 
  73.   
  74. - Sorry. So how does the Dash go about using this thing then?
  75.  
  76.   Your an ascii-character Dash, you can't use anything..
  77.   Anyway, there's no memory wasting cluttered gui to get in your way..
  78.   All you need is your CEd equivalent text-editor and start typing..
  79.  
  80. - But i have no fingers..
  81.  
  82.   Well pull them out of your a**e!
  83.  
  84. - Say theoretically, the great Dash whisks up this great super-stonking
  85.   animation/demo but everyone reads my script and just changes the
  86.   filenames and mess it all up and shake it all about and, and..?
  87.   That would really piss me off! or something.. er..
  88.  
  89.   No worries! Just send me all your money and i'll send you back your very
  90.   own registered-copy of the "AnimTRAC script-compiler" which will convert
  91.   your ascii-scripts into binary-scripts, for which some reason are much
  92.   smaller (must be missing some vital bytes?). Plus you get a say in what's
  93.   to be added/improved in future versions..
  94.  
  95. - What can possibly be improved? It sounds great as it is..
  96.   Okay then, what if i'm watching someone's animation and it's really bad
  97.   and i don't want to torture my shameless eyes anymore, or just want to
  98.   prematurely-eject or something?
  99.  
  100.   Just hold Escape and when it can it'll free-up.. As for improvements,
  101.   i wanted it to use datatypes so you could load gifs/pings etc but
  102.   didn't understand the datatypes.library.. Couldn't use DataConvert (as
  103.   found on the DataChrome(tm) disk) because it forgets to release half of
  104.   it's allocated memory (chip, why oh why does it have to use chip). Damn
  105.   gobble guts. DataChrome(tm)'s commercial right, well so it is but the file
  106.   DataConvert has no copyrights in it unlike the DataChrome executable..
  107.  
  108. - This package sounds like it needs commentating from Graham Hughes or
  109.   someone.. Anyway, now's about the time you scare everyone away by
  110.   announcing it requires the amos.library?
  111.  
  112.   HELL!! NO WAY!! NOT ON YOUR NELLY!! It was written in the legendary
  113.   Blitz Basic 2.1 (which i got for free somehow). No really, but all
  114.   the vital-speed stuff is hand-coded (not #!&%-coded) in pure assembler..
  115.   I luv 680x0 assembler by the way (intel's instruction set smells).. 
  116.   Also everything is in amiga mode, and very amiga friendly (i would never
  117.   stab amiga in the back! NOT!).
  118.  
  119. - Phew! I just hope he didn't quit reading before you could set me right..
  120.  
  121.   Well he's gone now so let's call him a dumb loser, pig-faced lump of s**t!
  122.  
  123. - Ha! Ha! Ha!
  124.  
  125.   Ho! Ho! Ho!
  126.  
  127. > Oakily doakily neighbour, howdily doodily todalily?
  128.  
  129.   NOOOOOOoooooo......!!
  130.  
  131.  
  132. And now it's time for something completely different(tm).
  133.  
  134.  
  135. The AnimTRAC! syntax/descriptions.. (oh joy!)
  136. -----------------------------------------------------------------------------
  137.  
  138.  
  139. loadframe frame#,"filename$"[,palette#][,chip]
  140. ---------
  141. Loads ILBM to frame in fastmem unless you type ,chip at the end. Optional to
  142. load it's palette..
  143.  
  144. loadbuffer frame#,"filename$"[,palette#}
  145. ----------
  146. Loads ILBM directly to back-buffer. Loading of it's palette is optional..
  147.  
  148. loadshape shape#,"filename$"[,palette#]
  149. ---------
  150. Loads ILBM as a shape, and it's palette if specified.. 
  151.  
  152. loadsample sample#,"filename$"
  153. ----------
  154. Loads 8SVX sample..
  155.  
  156. loadmodule module#,"filename$"
  157. ----------
  158. Loads ProTracker module..
  159.  
  160. loadpalette palette#,"filename$"
  161. -----------
  162. Loads palette..
  163.  
  164. freeframe frame#
  165. ---------
  166. Suprisingly removes frame from memory..
  167.  
  168. freeshape shape#
  169. ---------
  170.  
  171. freesample sample#
  172. ----------
  173.  
  174. freemodule module#
  175. ----------
  176.  
  177. freepalette palette#
  178. -----------
  179.  
  180. showframe frame#[,palette#][,chip]
  181. ---------
  182. Copys frame to back-buffer and shows with an optional palette. If you know
  183. the frames in chipmem you can add ,chip at the end to display it directly
  184. from where it is instantly as the front-buffer. Be careful though because if
  185. you do a showbuffer it will become the back-buffer and any editing will be
  186. directed to it, forever.. (ouh hu ha)
  187.  
  188. useframe #frame
  189. --------
  190. Copys frame to back-buffer for use..
  191.  
  192. copyframe frame#[,chip]
  193. ---------
  194. Copys front-buffer to specified frame.. If the frame already exists it will
  195. be overwritten.. An optional ,chip will put it in chipmem..
  196.  
  197. showbuffer [palette#]
  198. ----------
  199. Swaps buffers showing whatever was on the back-buffer..
  200.  
  201. doublebuffer
  202. ------------
  203. Copys front-buffer to back-buffer..
  204.  
  205. copybuffer #frame[,chip]
  206. ----------
  207. Same as copyframe only it copys the back-buffer instead..
  208.  
  209. drawshape #shape,xpos,ypos
  210. ---------
  211. Draws shape on back-buffer at specified x/y coordinates..
  212.  
  213. cutshape #shape,xpos,ypos,width,height
  214. --------
  215. Copys specified area from back-buffer to a shape..
  216.  
  217. playsample #sample,channel[,period]
  218. ----------
  219. Plays sample through specified channel at samples pre-set period/pitch, or
  220. can optionally play at a different pitch..
  221.  
  222. playmodule #module
  223. ----------
  224. Starts playing specified module..
  225.  
  226. stopmodule
  227. ----------
  228. Stops current module from playing..
  229.  
  230. maskmodule 0-15 (%4321)
  231. ----------
  232. When you first playmodule all channels are owned by the ProTracker player.
  233. Any samples played will be distorted because of ProTracker hogging all the
  234. channels. To mix a module/samples effectively you'll have to tell the
  235. ProTracker routine to leave the channels you want to use alone. Default
  236. mask value is 15 (%1111) which gives PT all channels. To use channels 3 and 4
  237. for samples you will have to mask them out with a value of 3 (%0011),
  238. %1 owned by PT..
  239.  
  240. setoffset offset
  241. ---------
  242. Sets the brightness-offset between -255 and 255, 0 being standard..
  243.  
  244. fadeoffset offset,spd
  245. ----------
  246. Fade offset from current to specified at what rate i.e. 1 being the slowest
  247. and 16 being the fastest..
  248.  
  249. scrollscreen xinc,yinc,loops[,delay]
  250. ------------
  251. Scrolls screen at how many x/y pixels a frame and how many times, 
  252. 0 does once, 1 twice etc. Also to really slow speed down add an optional
  253. delay that takes place between each increment..
  254.  
  255. vwait [#vwaits]
  256. -----
  257. Stop script for how many frames/verticle-blanks. showframe and showbuffer
  258. automatically do a vwait..
  259.  
  260. wait [#seconds]
  261. ----
  262. Stop script for how many seconds..
  263.  
  264. leftmouse
  265. ---------
  266. Waits until leftmouse button has been held and released before continuing..
  267.  
  268. rightmouse
  269. ----------
  270. Same as above only rightmouse this time.. Any need for a bothmouse?
  271.  
  272. NOTE: For a quick test edit the filenames in the examples..
  273.  
  274.  
  275. Possible annoyances..
  276. -----------------------------------------------------------------------------
  277.  
  278. 1.> Commands name MUST be in lower-case at present (sorry for shouting)..
  279.  
  280. 2.> If command has a syntax then there MUST be only ONE space between the
  281.     command and its syntax (sorry again)..
  282.  
  283. 3.> Command can start anywhere on the line.. (flexy-bill or what)
  284.  
  285. 4.> There's really only two annoyances..
  286.  
  287.  
  288. Great mysteries..
  289. -----------------------------------------------------------------------------
  290.  
  291. 1.> The bible is in the non-fiction section.
  292.  
  293. 2.> goto 1.> (fun for the first minute..)
  294.  
  295.  
  296. Params..
  297. -----------------------------------------------------------------------------
  298. AnimTRAC [-p priority and/or f] filename
  299.  
  300. Default priority is set at 9. To see your animation smoothly set it to 127
  301. as AmigaOS has a habit of ignoring your script at 9 and runs at a 
  302. non-consistant speed (workbench doing nothing seems to be more important)..
  303.  
  304. By adding f to the params loading ILBM's is much faster but needs memory
  305. for the file as apposed to unpacking ILBM's from disk which is slow (has no
  306. effect when loading shapes).
  307.  
  308. NOTE: To turn off cli-output just add >NIL: at the end..
  309.  
  310.  
  311. Additional questions from Dash..
  312. -----------------------------------------------------------------------------
  313.  
  314. - How many frames/shapes/samples etc can i have?
  315.  
  316.   As much as you have memory, or up to 1000 of each (0-999)..
  317.  
  318. - Can my files be xpk-packed?
  319.  
  320.   Yes, they doodily can. You should xpk-sqsh your modules and samples
  321.   as you gain better compression than if they were in a lha/lzx archive.
  322.   You can xpk the ascii/bin script file aswell..
  323.  
  324. - What about GIFs/PiNGs?
  325.  
  326.   Not in this version, but there is an alternative as xpk-packing ILBM files
  327.   is usually very poor as ILBM's are already poorly compressed in there own
  328.   poor way. Included is my own ILBM unpacker that converts the bitplanes to
  329.   chunky-bits, not chunky-bytes (except 8-bit offcourse). It's called
  330.   CBF (chunky-bits format), and once you've unpacked the the ILBM you should
  331.   then xpk-elzx/shri the file for better compression than any ILBM or GIF,
  332.   and sometimes even PNG.
  333.  
  334. - How does AnimTRAC unpack files?
  335.  
  336.   It uses xpk and cbf externally to temp (t:). For best speed make xpk
  337.   resident and copy CBF to ram:..
  338.  
  339.   NOTE: Low-memory users should assign t: to their hard-drive or something..
  340.  
  341. - How do i get my ILBM back from a CBF file?
  342.  
  343.   Just CBF it again and it will convert it back, as long as you
  344.   xpk-unpacked it before hand..
  345.  
  346. - Why is CBF so god damn slow?
  347.  
  348.   Because it's working with bits, not bytes..
  349.  
  350. - What is the different between a front-buffer and a back-buffer?
  351.  
  352.   The front-buffer is what you see and the back-buffer is what you cant see,
  353.   so you can work on it. Commands like showframe and useframe copy the frame
  354.   to the back-buffer, and showframe will swap the buffers revealing the frame
  355.   flicker-free (called double-buffering). The same is done when opening
  356.   new screens for frames with a new resolution and/or more bitplanes.
  357.   But there's only ever one screen because once the new screen is setup and
  358.   displayed the old screen is removed..
  359.  
  360. - Do i have to send you a HUGE royalty or something?
  361.  
  362.   HELL NO! Besides, in order to view it you have to use AnimTRAC anyway.
  363.   (i hate the royals anyway!)
  364.  
  365. - I don't understand the setoffset command..
  366.  
  367.   Whatever setoffset is set to is automatically added to the RGB's in the
  368.   currently used palette.. So it you set it to 125 any palette's used will
  369.   be 50% brighter, where as -125 will make any colours 50% darker.
  370.   Intended for smooth fade-ins and outs with the fadeoffset command.
  371.   Example: fadeoffset -255,1 will fade the offset to black slowly.. Any
  372.   palette's used from here on will start at black, allowing you to fade a
  373.   frame out, then fade a new frame in from black or you could setoffset to
  374.   0 again and when you next use a palette it will be back to normal..
  375.  
  376. - When loading files, can they be on different disks and will it load them
  377.   properly?
  378.  
  379.   Just as long as you write the volume name in with the filename.
  380.   e.g. anim_disk2:frames/frame.xpk 
  381.   When AnimTRAC wants the file the OS will takeover and request the volume
  382.   in a friendly manner before returning to your script.. (if its not present)
  383.  
  384.   NOTE: volume names can have spaces..
  385.         e.g. "bobs sick anim-disk:" or "ram disk:"
  386.  
  387.  
  388. Last words..
  389. -----------------------------------------------------------------------------
  390. AnimTRAC!(tm) was written on an A1200 with a measly 40MB hard-drive and
  391. 4MB fastmem using Blitz Basic 2.1 (with in-built 68000 assembler).
  392. Should work on 2.0 and up?
  393.  
  394. I'd like to thank Ron the bus-driver, for helping out a guy who was
  395. down on his luck with no place to go.. err.. just kidding!
  396.  
  397. (EXTRACTED :-> HUGE-MUNGIS list of thank-you's to computer-users/freaks
  398.                i don't know or whom have nothing to do with this.
  399.                Hate to break a trend and all.. sorry.. no, REALLY!!)
  400.                
  401. The real reason it's Called AnimTRAC is coz it's dedicated to the guys at
  402. "SingleTRAC(tm)", America. Who the f**k are they? Well they've made/making
  403. the best ever PlayStation(tm) games yet. Warhawk and Twisted Metal 2 kick
  404. serious a**e (possessers of great gameplay). Can't wait for Critical Depth..
  405. In this paragraph also comes some advice for future Amiga-dumpers come
  406. PC-bumpers. If you want games keep your Amiga and get a Sony PlayStation(tm)
  407. (i'm expecting some free games real soon for this plug!). Besides, i've
  408. had my A1200 since 1994. Why have i still got it? (and a 500 before that)
  409.  
  410.  
  411. For the AnimTRAC script-compiler send either:
  412.  
  413. - 10 UK£  (soccer sux badly! rugby and cricket rulz!)
  414. - 15 US$  (take those pads off and play rugby! your rugby commentators suck!)
  415. - 20 NZ$  (i think this one is most preferable.. or something..)
  416. - 20 AUS$ (who somehow kicked the springboks? only we're allowed to do that!)
  417. - 50,000,000 YEN (self-explainatory..)
  418.  
  419.          To: Martin Edwards,
  420. Before October 1997: 93 Norfolk Cresent, (no time-travellers please!)
  421. October and onwards: 32 Scott Ave,
  422.                  Otaki,
  423.                  North Island,
  424.                      New Zealand.
  425.  
  426. email: ihavenonetaccountornothingsodontbotherbesidesitwouldgetreallost.co.nz
  427.  
  428. Features of the AnimTRAC script-compiler..
  429.  
  430. - Small executable (by what measures?)
  431. - A chance to send money to someone in New Zealand for the first time
  432. - Converts ascii-scripts to binary-scripts (suprisingly)
  433. - Help fund the best war-game-in-progress the amiga's ever seen since Dune 2
  434. - Get the latest word on how it's going and all that
  435. - Some other stuff
  436. - Thats about all really
  437. - I'll die from starvation if you don't
  438. - (cough! gag gag! chuck! barf! errghhhhh, hoik... gulp... yummy!)
  439. - (fill this space)
  440.  
  441. Look! Ten great features, for so little money. It's got to be worth it.
  442. What are you waiting for, an infomercial..
  443.